Cancel job for requested jobId.

Version: 24.03

Cancel job for requested jobId.

Path Parameters

id uuid required
Possible values: >= 36 characters and <= 36 characters
Id of the job.
Example: 6c311d29-5753-46d4-b32c-19b918ea93b0

Responses

Job with requested jobId canceled.

application/json

Schema
Example (from schema)
Complete

Schema

completedOn date-time
createdOn date-time
exception object
Job error details.
errorDetail string
Possible values: <= 4000 characters
Detailed exception information.
exception string
Possible values: <= 100 characters
Exception name.
exceptionDate date-time
Datetime error occurs.
globalAssetId string
Possible values: >= 45 characters and <= 45 characters, Value must match regular expression ^urn:uuid:[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$
Part global unique id in the format urn:uuid:uuid4.
id uuid
Possible values: >= 36 characters and <= 36 characters, Value must match regular expression /^[0-9a-f]{8}-[0-9a-f]{4}-[0-5][0-9a-f]{3}-[089ab][0-9a-f]{3}-[0-9a-f]{12}$/i
Id of the job.
lastModifiedOn date-time
owner string
The IRS api consumer.
parameter object
Job parameter of job processing.
aspects string
bomLifecycle string
Possible values: [asBuilt, asPlanned, asSpecified]
The lifecycle context in which the child part was assembled into the parent part.
bpn string
callbackUrl string
collectAspects boolean
depth int32
Possible values: <= 2147483647
direction string
Possible values: [upward, downward]
Item graph traversal direction.
lookupBPNs boolean
startedOn date-time
state string
Possible values: [UNSAVED, INITIAL, RUNNING, TRANSFERS_FINISHED, COMPLETED, CANCELED, ERROR]
summary object
Summary of the job with statistics of the job processing.
asyncFetchedItems object
Statistics of job execution.
completed int32
Possible values: <= 2147483647
Number of completed item transfers.
failed int32
Possible values: <= 2147483647
Number of failed item transfers.
running int32
Possible values: <= 2147483647
Number of running item transfers.
bpnLookups object
Statistics of job execution.
completed int32
Possible values: <= 2147483647
Number of completed item transfers.
failed int32
Possible values: <= 2147483647
Number of failed item transfers.
running int32
Possible values: <= 2147483647
Number of running item transfers.

{
  "completedOn": "2022-02-03T14:48:54.709Z",
  "createdOn": "2022-02-03T14:48:54.709Z",
  "exception": {
    "errorDetail": "Timeout while requesting Digital Registry",
    "exception": "IrsTimeoutException",
    "exceptionDate": "2022-02-03T14:48:54.709Z"
  },
  "globalAssetId": "urn:uuid:6c311d29-5753-46d4-b32c-19b918ea93b0",
  "id": "e5347c88-a921-11ec-b909-0242ac120002",
  "lastModifiedOn": "2022-02-03T14:48:54.709Z",
  "owner": "string",
  "parameter": {
    "aspects": "SerialPart",
    "bomLifecycle": "asBuilt",
    "bpn": "BPNL00000003AYRE",
    "callbackUrl": "https://hostname.com/callback?id={id}&state={state}",
    "collectAspects": false,
    "depth": 1,
    "direction": "upward",
    "lookupBPNs": false
  },
  "startedOn": "2022-02-03T14:48:54.709Z",
  "state": "COMPLETED",
  "summary": {
    "asyncFetchedItems": {
      "completed": 0,
      "failed": 0,
      "running": 0
    },
    "bpnLookups": {
      "completed": 0,
      "failed": 0,
      "running": 0
    }
  }
}

{
  "completedOn": "2022-02-03T14:48:54.709Z",
  "globalAssetId": "urn:uuid:6c311d29-5753-46d4-b32c-19b918ea93b0",
  "id": "6c311d29-5753-46d4-b32c-19b918ea93b0",
  "lastModifiedOn": "2022-02-03T14:48:54.709Z",
  "startedOn": "2022-02-03T14:48:54.709Z",
  "state": "CANCELED"
}

Cancel job failed.

application/json

Schema
Example (from schema)
Error

Schema

error string
Error.
messages string[]
Possible values: <= 2147483647
List of error messages.
statusCode string
Possible values: [100 CONTINUE, 101 SWITCHING_PROTOCOLS, 102 PROCESSING, 103 EARLY_HINTS, 103 CHECKPOINT, 200 OK, 201 CREATED, 202 ACCEPTED, 203 NON_AUTHORITATIVE_INFORMATION, 204 NO_CONTENT, 205 RESET_CONTENT, 206 PARTIAL_CONTENT, 207 MULTI_STATUS, 208 ALREADY_REPORTED, 226 IM_USED, 300 MULTIPLE_CHOICES, 301 MOVED_PERMANENTLY, 302 FOUND, 302 MOVED_TEMPORARILY, 303 SEE_OTHER, 304 NOT_MODIFIED, 305 USE_PROXY, 307 TEMPORARY_REDIRECT, 308 PERMANENT_REDIRECT, 400 BAD_REQUEST, 401 UNAUTHORIZED, 402 PAYMENT_REQUIRED, 403 FORBIDDEN, 404 NOT_FOUND, 405 METHOD_NOT_ALLOWED, 406 NOT_ACCEPTABLE, 407 PROXY_AUTHENTICATION_REQUIRED, 408 REQUEST_TIMEOUT, 409 CONFLICT, 410 GONE, 411 LENGTH_REQUIRED, 412 PRECONDITION_FAILED, 413 PAYLOAD_TOO_LARGE, 413 REQUEST_ENTITY_TOO_LARGE, 414 URI_TOO_LONG, 414 REQUEST_URI_TOO_LONG, 415 UNSUPPORTED_MEDIA_TYPE, 416 REQUESTED_RANGE_NOT_SATISFIABLE, 417 EXPECTATION_FAILED, 418 I_AM_A_TEAPOT, 419 INSUFFICIENT_SPACE_ON_RESOURCE, 420 METHOD_FAILURE, 421 DESTINATION_LOCKED, 422 UNPROCESSABLE_ENTITY, 423 LOCKED, 424 FAILED_DEPENDENCY, 425 TOO_EARLY, 426 UPGRADE_REQUIRED, 428 PRECONDITION_REQUIRED, 429 TOO_MANY_REQUESTS, 431 REQUEST_HEADER_FIELDS_TOO_LARGE, 451 UNAVAILABLE_FOR_LEGAL_REASONS, 500 INTERNAL_SERVER_ERROR, 501 NOT_IMPLEMENTED, 502 BAD_GATEWAY, 503 SERVICE_UNAVAILABLE, 504 GATEWAY_TIMEOUT, 505 HTTP_VERSION_NOT_SUPPORTED, 506 VARIANT_ALSO_NEGOTIATES, 507 INSUFFICIENT_STORAGE, 508 LOOP_DETECTED, 509 BANDWIDTH_LIMIT_EXCEEDED, 510 NOT_EXTENDED, 511 NETWORK_AUTHENTICATION_REQUIRED]
Error code.

{
  "error": "string",
  "messages": [
    "string"
  ],
  "statusCode": "100 CONTINUE"
}

{
  "error": "Bad request",
  "messages": [
    "BadRequestException"
  ],
  "statusCode": "400 BAD_REQUEST"
}

No valid authentication credentials.

application/json

Schema
Example (from schema)
Error

Schema

error string
Error.
messages string[]
Possible values: <= 2147483647
List of error messages.
statusCode string
Possible values: [100 CONTINUE, 101 SWITCHING_PROTOCOLS, 102 PROCESSING, 103 EARLY_HINTS, 103 CHECKPOINT, 200 OK, 201 CREATED, 202 ACCEPTED, 203 NON_AUTHORITATIVE_INFORMATION, 204 NO_CONTENT, 205 RESET_CONTENT, 206 PARTIAL_CONTENT, 207 MULTI_STATUS, 208 ALREADY_REPORTED, 226 IM_USED, 300 MULTIPLE_CHOICES, 301 MOVED_PERMANENTLY, 302 FOUND, 302 MOVED_TEMPORARILY, 303 SEE_OTHER, 304 NOT_MODIFIED, 305 USE_PROXY, 307 TEMPORARY_REDIRECT, 308 PERMANENT_REDIRECT, 400 BAD_REQUEST, 401 UNAUTHORIZED, 402 PAYMENT_REQUIRED, 403 FORBIDDEN, 404 NOT_FOUND, 405 METHOD_NOT_ALLOWED, 406 NOT_ACCEPTABLE, 407 PROXY_AUTHENTICATION_REQUIRED, 408 REQUEST_TIMEOUT, 409 CONFLICT, 410 GONE, 411 LENGTH_REQUIRED, 412 PRECONDITION_FAILED, 413 PAYLOAD_TOO_LARGE, 413 REQUEST_ENTITY_TOO_LARGE, 414 URI_TOO_LONG, 414 REQUEST_URI_TOO_LONG, 415 UNSUPPORTED_MEDIA_TYPE, 416 REQUESTED_RANGE_NOT_SATISFIABLE, 417 EXPECTATION_FAILED, 418 I_AM_A_TEAPOT, 419 INSUFFICIENT_SPACE_ON_RESOURCE, 420 METHOD_FAILURE, 421 DESTINATION_LOCKED, 422 UNPROCESSABLE_ENTITY, 423 LOCKED, 424 FAILED_DEPENDENCY, 425 TOO_EARLY, 426 UPGRADE_REQUIRED, 428 PRECONDITION_REQUIRED, 429 TOO_MANY_REQUESTS, 431 REQUEST_HEADER_FIELDS_TOO_LARGE, 451 UNAVAILABLE_FOR_LEGAL_REASONS, 500 INTERNAL_SERVER_ERROR, 501 NOT_IMPLEMENTED, 502 BAD_GATEWAY, 503 SERVICE_UNAVAILABLE, 504 GATEWAY_TIMEOUT, 505 HTTP_VERSION_NOT_SUPPORTED, 506 VARIANT_ALSO_NEGOTIATES, 507 INSUFFICIENT_STORAGE, 508 LOOP_DETECTED, 509 BANDWIDTH_LIMIT_EXCEEDED, 510 NOT_EXTENDED, 511 NETWORK_AUTHENTICATION_REQUIRED]
Error code.

{
  "error": "string",
  "messages": [
    "string"
  ],
  "statusCode": "100 CONTINUE"
}

{
  "error": "Unauthorized",
  "messages": [
    "UnauthorizedException"
  ],
  "statusCode": "401 UNAUTHORIZED"
}

Authorization refused by server.

application/json

Schema
Example (from schema)
Error

Schema

error string
Error.
messages string[]
Possible values: <= 2147483647
List of error messages.
statusCode string
Possible values: [100 CONTINUE, 101 SWITCHING_PROTOCOLS, 102 PROCESSING, 103 EARLY_HINTS, 103 CHECKPOINT, 200 OK, 201 CREATED, 202 ACCEPTED, 203 NON_AUTHORITATIVE_INFORMATION, 204 NO_CONTENT, 205 RESET_CONTENT, 206 PARTIAL_CONTENT, 207 MULTI_STATUS, 208 ALREADY_REPORTED, 226 IM_USED, 300 MULTIPLE_CHOICES, 301 MOVED_PERMANENTLY, 302 FOUND, 302 MOVED_TEMPORARILY, 303 SEE_OTHER, 304 NOT_MODIFIED, 305 USE_PROXY, 307 TEMPORARY_REDIRECT, 308 PERMANENT_REDIRECT, 400 BAD_REQUEST, 401 UNAUTHORIZED, 402 PAYMENT_REQUIRED, 403 FORBIDDEN, 404 NOT_FOUND, 405 METHOD_NOT_ALLOWED, 406 NOT_ACCEPTABLE, 407 PROXY_AUTHENTICATION_REQUIRED, 408 REQUEST_TIMEOUT, 409 CONFLICT, 410 GONE, 411 LENGTH_REQUIRED, 412 PRECONDITION_FAILED, 413 PAYLOAD_TOO_LARGE, 413 REQUEST_ENTITY_TOO_LARGE, 414 URI_TOO_LONG, 414 REQUEST_URI_TOO_LONG, 415 UNSUPPORTED_MEDIA_TYPE, 416 REQUESTED_RANGE_NOT_SATISFIABLE, 417 EXPECTATION_FAILED, 418 I_AM_A_TEAPOT, 419 INSUFFICIENT_SPACE_ON_RESOURCE, 420 METHOD_FAILURE, 421 DESTINATION_LOCKED, 422 UNPROCESSABLE_ENTITY, 423 LOCKED, 424 FAILED_DEPENDENCY, 425 TOO_EARLY, 426 UPGRADE_REQUIRED, 428 PRECONDITION_REQUIRED, 429 TOO_MANY_REQUESTS, 431 REQUEST_HEADER_FIELDS_TOO_LARGE, 451 UNAVAILABLE_FOR_LEGAL_REASONS, 500 INTERNAL_SERVER_ERROR, 501 NOT_IMPLEMENTED, 502 BAD_GATEWAY, 503 SERVICE_UNAVAILABLE, 504 GATEWAY_TIMEOUT, 505 HTTP_VERSION_NOT_SUPPORTED, 506 VARIANT_ALSO_NEGOTIATES, 507 INSUFFICIENT_STORAGE, 508 LOOP_DETECTED, 509 BANDWIDTH_LIMIT_EXCEEDED, 510 NOT_EXTENDED, 511 NETWORK_AUTHENTICATION_REQUIRED]
Error code.

{
  "error": "string",
  "messages": [
    "string"
  ],
  "statusCode": "100 CONTINUE"
}

{
  "error": "Forbidden",
  "messages": [
    "ForbiddenException"
  ],
  "statusCode": "403 FORBIDDEN"
}

Job for requested jobId not found.

application/json

Schema
Example (from schema)
Error

Schema

error string
Error.
messages string[]
Possible values: <= 2147483647
List of error messages.
statusCode string
Possible values: [100 CONTINUE, 101 SWITCHING_PROTOCOLS, 102 PROCESSING, 103 EARLY_HINTS, 103 CHECKPOINT, 200 OK, 201 CREATED, 202 ACCEPTED, 203 NON_AUTHORITATIVE_INFORMATION, 204 NO_CONTENT, 205 RESET_CONTENT, 206 PARTIAL_CONTENT, 207 MULTI_STATUS, 208 ALREADY_REPORTED, 226 IM_USED, 300 MULTIPLE_CHOICES, 301 MOVED_PERMANENTLY, 302 FOUND, 302 MOVED_TEMPORARILY, 303 SEE_OTHER, 304 NOT_MODIFIED, 305 USE_PROXY, 307 TEMPORARY_REDIRECT, 308 PERMANENT_REDIRECT, 400 BAD_REQUEST, 401 UNAUTHORIZED, 402 PAYMENT_REQUIRED, 403 FORBIDDEN, 404 NOT_FOUND, 405 METHOD_NOT_ALLOWED, 406 NOT_ACCEPTABLE, 407 PROXY_AUTHENTICATION_REQUIRED, 408 REQUEST_TIMEOUT, 409 CONFLICT, 410 GONE, 411 LENGTH_REQUIRED, 412 PRECONDITION_FAILED, 413 PAYLOAD_TOO_LARGE, 413 REQUEST_ENTITY_TOO_LARGE, 414 URI_TOO_LONG, 414 REQUEST_URI_TOO_LONG, 415 UNSUPPORTED_MEDIA_TYPE, 416 REQUESTED_RANGE_NOT_SATISFIABLE, 417 EXPECTATION_FAILED, 418 I_AM_A_TEAPOT, 419 INSUFFICIENT_SPACE_ON_RESOURCE, 420 METHOD_FAILURE, 421 DESTINATION_LOCKED, 422 UNPROCESSABLE_ENTITY, 423 LOCKED, 424 FAILED_DEPENDENCY, 425 TOO_EARLY, 426 UPGRADE_REQUIRED, 428 PRECONDITION_REQUIRED, 429 TOO_MANY_REQUESTS, 431 REQUEST_HEADER_FIELDS_TOO_LARGE, 451 UNAVAILABLE_FOR_LEGAL_REASONS, 500 INTERNAL_SERVER_ERROR, 501 NOT_IMPLEMENTED, 502 BAD_GATEWAY, 503 SERVICE_UNAVAILABLE, 504 GATEWAY_TIMEOUT, 505 HTTP_VERSION_NOT_SUPPORTED, 506 VARIANT_ALSO_NEGOTIATES, 507 INSUFFICIENT_STORAGE, 508 LOOP_DETECTED, 509 BANDWIDTH_LIMIT_EXCEEDED, 510 NOT_EXTENDED, 511 NETWORK_AUTHENTICATION_REQUIRED]
Error code.

{
  "error": "string",
  "messages": [
    "string"
  ],
  "statusCode": "100 CONTINUE"
}

{
  "error": "Not found",
  "messages": [
    "NotFoundException"
  ],
  "statusCode": "404 NOT_FOUND"
}

Cancel job for requested jobId.​

Cancel job for requested jobId.